MarkLogic 12 Product Documentation
GET /manage/v2/databases/{id|name}/partitions/{name}Summary
Retrieve a partition summary that includes links to related resources, such as
the containing database, member forests, assignment policy, and the partition configuration.
| URL Parameters |
| format |
The format of the data in the response body.
Allowed values: html, json, or xml. Use this
parameter to override the Accept header. |
| Request Headers |
| Accept |
The desired MIME type of the data in the response
body. If the format parameter is present, it takes precedence over this header.
Supported values: application/xml (default), application/json,
text/html. |
| Content-type |
The MIME type of the data in the request
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html. |
| Response Headers |
| Content-type |
The MIME type of the data in the response
body. Use the Accept header or format request parameter to specify a preferred
format. The format parameter takes precedence over the Accept header if both
are present. |
Response
Upon success, MarkLogic server returns status code 200 (OK) and the response
body contains the partition summary, in the requested format. A status code of 401
(Unauthorized) is returned if the user does not have the necessary privileges.
Required Privileges
This operation requires the
manage-user role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
The structure of the output returned from
this REST API is as follows:
metaProperties of the view rather than the resource.
This is a complex structure with the following children:
uriThe path to the view.
current-timeThe timestamp for when the view was generated.
elapsed-timeThe time required to construct the view. The
elapsed time indicates the relative cost of generating the view. Consider
the cost when determining how frequently to request a view.
start-minThe timestamp for filtering out more recent
requests or transactions.
view-errorAn error limiting the data in the view.
This is a complex structure with the following children:
error-typeThe kind of error.
error-nameThe name of the error.
error-codeThe error identifier.
error-messageThe error text.
relationsRelationships to resources.
This is a complex structure with the following children:
relation-groupRelated resources with the same type.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
rolerefA role that distinguishes the resource.
relation-countThe number of related resources.
relationA specific related resource.
This is a complex structure with the following children:
qualifiersA list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifierAnother resource that qualifies the resource.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
rolerefA role that distinguishes the resource.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
assignment-policy
The policy to use for assignment and rebalancing.
This is a complex structure with the following children:
assignment-policy-name
What policy to use for assignment and rebalancing.
partition-key
The partition key of the range assignment policy.
This is a complex structure with the following children:
cts:base-reference
lower-bound-included
If this is true, ranges on all forests in this database include the
lower bound but not the upper bound (i.e., [lower-bound, upper-bound));
if this is false, ranges on all forests include the upper bound
but not the lower bound (i.e., (lower-bound, upper-bound]).
default-partition
If a document does not match any queries in all the partitions,
it will be inserted into the default-partition.
range
Range configuration for the range assignment policy.
This is a complex structure with the following children:
lower-bound
The lower bound of the range on the forest.
upper-bound
The upper bound of the range on the forest.
partition-forest
This is a complex structure with the following children:
forest-name
The forest name.
hostA host name or id.
data-directory
The optional public directory for forests.
large-data-directory
The optional directory for large objects in a forest.
fast-data-directory
The optional smaller but faster directory for forests.
forest-replicasReplica forest definitions.
This is a complex structure with the following children:
forest-replicaReplica forest definition.
This is a complex structure with the following children:
replica-nameName of the replica forest.
hostA host name or id.
data-directory
The optional public directory for forests.
large-data-directory
The optional directory for large objects in a forest.
fast-data-directory
The optional smaller but faster directory for forests.
related-viewsA list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-viewA broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-typeThe kind of view.
view-nameThe name of the view.
view-uriThe path for the view.
Example
http://localhost:8002/manage/v2/databases/example-db/partitions/2011
==> Returns information about the partition 2011 in the database example-db.
Copyright © 2025 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.